/*
 * Copyright 2006-2018 The MZmine 2 Development Team
 * 
 * This file is part of MZmine 2.
 * 
 * MZmine 2 is free software; you can redistribute it and/or modify it under the terms of the GNU
 * General Public License as published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 * 
 * MZmine 2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along with MZmine 2; if not,
 * write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
 * USA
 */

package net.sf.mzmine.parameters;

import javax.swing.JComponent;

/**
 * Parameter interface, represents parameters or variables used in the project
 */
public interface UserParameter<ValueType, EditorComponent extends JComponent>
    extends Parameter<ValueType> {

  /**
   * 
   * @return Detailed description of the parameter
   */
  public String getDescription();

  public EditorComponent createEditingComponent();

  public void setValueFromComponent(EditorComponent component);

  public void setValueToComponent(EditorComponent component, ValueType newValue);

  public UserParameter<ValueType, EditorComponent> cloneParameter();

}
